PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_prospects

Retrieves a person_prospects resource.

Retrieves a person_prospects resource.

Authorizations:
JWT
path Parameters
id
required
string

person_prospects identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "status": {
    },
  • "referencedBy": "string",
  • "employee": {
    },
  • "type": {
    },
  • "person": {
    },
  • "industry": {
    },
  • "expertise": "string",
  • "neq": 0,
  • "icriq": 0,
  • "nbEmployees": 0,
  • "turnover": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "distance": "string",
  • "projectType": {
    },
  • "budget": "string",
  • "notes": "string",
  • "competitor": "string",
  • "potential": "string",
  • "owningCorporation": {
    },
  • "shortcode": "PR",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "internalAbbreviation": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the person_prospects resource.

Replaces the person_prospects resource.

Authorizations:
JWT
path Parameters
id
required
string

person_prospects identifier

Request Body schema:
required

The updated person_prospects resource

required
object (person_prospect_statuses.jsonld-add_post)

ProspectStatus.

referencedBy
string or null
object (person_employees.jsonld-add_post)

Employes.

internalabbreviation
string or null
person_prospect_types.jsonld-add_post (object) or null
required
object (people.jsonld-add_post)

Person.

person_industries.jsonld-add_post (object) or null
expertise
string or null
neq
integer or null
icriq
integer or null
nbEmployees
required
integer
turnover
required
string
creationDate
required
string <date-time>
distance
required
string
project_types.jsonld-add_post (object) or null
budget
required
string
notes
string or null
competitor
string or null
potential
required
string
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "status": {
    },
  • "referencedBy": "string",
  • "employee": {
    },
  • "internalabbreviation": "string",
  • "type": {
    },
  • "person": {
    },
  • "industry": {
    },
  • "expertise": "string",
  • "neq": 0,
  • "icriq": 0,
  • "nbEmployees": 0,
  • "turnover": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "distance": "string",
  • "projectType": {
    },
  • "budget": "string",
  • "notes": "string",
  • "competitor": "string",
  • "potential": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "status": {
    },
  • "referencedBy": "string",
  • "employee": {
    },
  • "type": {
    },
  • "person": {
    },
  • "industry": {
    },
  • "expertise": "string",
  • "neq": 0,
  • "icriq": 0,
  • "nbEmployees": 0,
  • "turnover": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "distance": "string",
  • "projectType": {
    },
  • "budget": "string",
  • "notes": "string",
  • "competitor": "string",
  • "potential": "string",
  • "owningCorporation": {
    },
  • "shortcode": "PR",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "internalAbbreviation": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the person_prospects resource.

Removes the person_prospects resource.

Authorizations:
JWT
path Parameters
id
required
string

person_prospects identifier

Responses